API Documentation
Static Public Member Functions | List of all members
nkAstraeus::nkTasksWrap::ThreadSubmittedWorkWrapper Class Referencefinal

Wraps a nkTasks::ThreadSubmittedWork and offers functions for use in scripting. More...

Static Public Member Functions

static void updateEnvironment (nkScripts::Environment *env)
 
static void destructor (void *toDestroy)
 
static nkScripts::OutputValue cancel (const nkScripts::DataStack &stack)
 

Detailed Description

Wraps a nkTasks::ThreadSubmittedWork and offers functions for use in scripting.

Member Function Documentation

◆ updateEnvironment()

static void nkAstraeus::nkTasksWrap::ThreadSubmittedWorkWrapper::updateEnvironment ( nkScripts::Environment env)
static

Updates a given environment and set it up to use all functions wrapped by this wrapper.

Parameters
envThe environment to set up.

◆ destructor()

static void nkAstraeus::nkTasksWrap::ThreadSubmittedWorkWrapper::destructor ( void *  toDestroy)
static

Wrapper function for the destructor of the user type.

Parameters
toDestroyThe data that has to be freed.

◆ cancel()

static nkScripts::OutputValue nkAstraeus::nkTasksWrap::ThreadSubmittedWorkWrapper::cancel ( const nkScripts::DataStack stack)
static

Wrapper function for nkTasks::ThreadSubmittedWork::cancel().

local r = t:cancel() ;
Parameters
stackThe parameter stack.
Returns
The output value, as a bool.

The documentation for this class was generated from the following file: